home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / snmp / mib2c-data / mfd-interactive-setup.m2c < prev    next >
Text File  |  2008-09-22  |  12KB  |  333 lines

  1. #######################################################################
  2. ## generic include for XXX. Do not use directly.
  3. ##
  4. ## $Id: mfd-interactive-setup.m2c 16380 2007-05-17 18:06:33Z rstory $
  5. ########################################################################
  6. @if $m2c_mark_boundary == 1@
  7. /** START code generated by $RCSfile$ $Revision: 16380 $ */
  8. @end@
  9. ########################################################################
  10. @eval $m2c_temp_writable = table_is_writable($context)@
  11. @eval $m2c_temp_create = table_has_create($context)@
  12. @eval $m2c_temp_dependencies = $m2c_temp_writable@
  13. @eval $m2c_temp_context_reg = "$mfd_default_context_reg"@
  14. @eval $m2c_temp_data_context = "$mfd_default_data_context"@
  15. @eval $m2c_temp_data_allocate = $mfd_default_data_allocate@
  16. @eval $m2c_temp_data_cache = $mfd_default_data_cache@
  17. @eval $m2c_temp_undo_embed = $mfd_default_undo_embed@
  18. @eval $m2c_temp_data_init = $mfd_default_data_init@
  19. @eval $m2c_temp_persistent = $m2c_temp_writable@
  20. @eval $m2c_temp_table_access = "$mfd_default_table_access"@
  21. @eval $m2c_temp_data_transient = $mfd_default_data_transient@
  22. @eval $m2c_temp_include_examples = $mfd_default_include_examples@
  23. @eval $m2c_temp_table_skip_mapping = $mfd_default_table_skip_mapping@
  24. @eval $m2c_temp_table_sparse = $mfd_default_data_sparse@
  25. @eval $m2c_temp_generate_makefile = $mfd_default_generate_makefile@
  26. @eval $m2c_temp_generate_subagent = $mfd_default_generate_subagent@
  27. ##
  28. @if $mfd_interactive_setup != 0@
  29. @open -@
  30. @   if $mfd_interactive_setup != -1@
  31. There are no defaults for ${context}. Would you like to
  32.  
  33.   1) Accept hard-coded defaults
  34.   2) Set defaults now [DEFAULT]
  35.  
  36. @     eval $ans = 2@
  37. @     prompt $ans Select your choice : @
  38. @   else@
  39. @      eval $ans = 2@
  40. @   end@
  41. @   if $ans == 1@
  42. @   else@
  43.  
  44.  
  45. ## ---------------------------------------------------
  46. @    if $m2c_temp_writable == 1@
  47. This table has writable columns. Do you want to generate
  48. code for writeable columns, or restrict the table to read-only?
  49.  
  50.   1) generate code with writeable columns [DEFAULT]
  51.   2) generate code with read-only columns
  52.  
  53. @      prompt $ans Select your choice : @
  54. @      if $ans == 2@
  55. @        eval $m2c_temp_writable = 0@
  56. @        eval $m2c_temp_create = 0@
  57. @        eval $m2c_temp_dependencies = 0@
  58. @        eval $m2c_temp_persistent = 0@
  59. @      end@
  60.  
  61.  
  62. @    end@ # writable
  63. ## ---------------------------------------------------
  64. @    if $m2c_temp_persistent == 1@
  65. @        eval $m2c_temp_persistent = 0@
  66. Since your table is writable, do you want to generate code to save and
  67. restore rows in the Net-SNMP persistent store? You should only use this
  68. option if the agent 'owns' the data, and doesn't get the data from an
  69. external source.
  70.  
  71.   1) do not generate persistent store code [DEFAULT]
  72.   2) generate persistent store code
  73.  
  74. @      prompt $ans Select your choice : @
  75. @      if $ans == 2@
  76. @        eval $m2c_temp_persistent = 1@
  77. @      end@
  78.  
  79.  
  80. @    end@ # persistent
  81. ## ---------------------------------------------------
  82. @    if $m2c_temp_dependencies == 1@
  83. @        eval $m2c_temp_dependencies = 0@
  84. Writable tables sometimes have dependencies beteen columns
  85. or with other tables. If there are no dependencies in this table, you
  86. probably do not want the extra code.
  87.  
  88.   1) do not generate dependency code [DEFAULT]
  89.   2) generate dependency code
  90.  
  91. @      prompt $ans Select your choice : @
  92. @      if $ans == 2@
  93. @        eval $m2c_temp_dependencies = 1@
  94. @      end@
  95.  
  96.  
  97. @    end@ # dependencies
  98. ## ---------------------------------------------------
  99. @    if $m2c_temp_create == 1@
  100. This table has read-create columns. Do you want to generate
  101. code for dynamic row creation?
  102.  
  103.   1) generate code for row creation [DEFAULT]
  104.   2) do not generate code for row creation
  105.  
  106. @      prompt $ans Select your choice : @
  107. @      if $ans == 2@
  108. @        eval $m2c_temp_create = 0@
  109. @      end@
  110.  
  111.  
  112. @    end@ # create
  113. ## ---------------------------------------------------
  114. Do you want to use an existing data structure for the USER context?
  115. This would be a structure used to track data for the entire table,
  116. (similar to a global variable) not individual rows.
  117.  
  118.   1) No, use $m2c_temp_context_reg [DEFAULT]
  119.   2) Yes, use my own structure
  120.  
  121. @      prompt $ans Select your choice : @
  122. @      if $ans == 2@
  123. @        prompt $m2c_temp_context_reg   Enter your USER context : @
  124. @      end@
  125.  
  126.  
  127. ## ---------------------------------------------------
  128. Do you want to use an existing data structure for the DATA context?
  129. The DATA context holds the data for each MIB column. By default, a new
  130. data structure will be created with an element for each column.
  131.  
  132.   1) No, use $m2c_temp_data_context [DEFAULT]
  133.   2) Yes, use my own structure
  134.  
  135. @      prompt $ans Select your choice : @
  136. @      if $ans == 2@
  137.  
  138.  
  139. Note: Do not enter a pointer type. Use the base structure name. For
  140. example, use 'struct widget', not 'struct widget *'. If you will be
  141. using pointer to the structure, select dynamic allocation in the
  142. next question.
  143.  
  144. @        prompt $m2c_temp_data_context   Enter your DATA context : @
  145. @      end@
  146.  
  147.  
  148. ## ---------------------------------------------------
  149. @      if "x$m2c_temp_data_context" ne "x$mfd_default_data_context"@
  150. Do you want to allocate your '$m2c_temp_data_context' DATA context, or
  151. embed it directly? If your data is INTERNAL (controlled by the agent), you
  152. probably want embedded. If your data is EXTERNAL (controlled by another
  153. process) and you have pointers to the data, you probably want allocated.
  154.  
  155.   1) directly embed structure [DEFAULT]
  156.   2) dynamically allocate structure
  157.  
  158. @        prompt $ans Select your choice : @
  159. @        if $ans == 2@
  160. @          eval $m2c_temp_data_allocate = 1@
  161. @        end@
  162.  
  163.  
  164. @      end@ # ! default (generated)
  165. ## ---------------------------------------------------
  166. Do you need to initialize elements in the '$m2c_temp_data_context' DATA
  167. context when a new instance is created (eg default values, or other structures
  168. you are going to add that might need initialization to the row request context?
  169. (The most common reasons you might need to do this is are if you want to keep
  170. some non-MIB data for every row, or some columns have default values.)
  171.  
  172.   1) no, no initialization needed
  173.   2) yes, initilization is needed [DEFAULT]
  174.  
  175. @        prompt $ans Select your choice : @
  176. @        if $ans == 1@
  177. @          eval $m2c_temp_data_init = 0@
  178. @        end@
  179.  
  180.  
  181. ## ---------------------------------------------------
  182. Do you plan on keeping all data in the format defined by the MIB? If so,
  183. no functions will be generated to map values. If some data will be
  184. stored in a different format, the mapping functions will be generated.
  185. If your MIB has integers with enumerations, mapping functions are more
  186. likely to be needed. (e.g. A TruthValue object will hold the value
  187. 1 or 2, but a C boolean would be 1 or 0.)
  188.  
  189.   1) All values will be stored as defined by the MIB [DEFAULT]
  190.   2) I need to map values to the format defined by the MIB.
  191.  
  192. @        prompt $ans Select your choice : @
  193. @        if $ans == 2@
  194. @          eval $m2c_temp_table_skip_mapping = -1@
  195. @        end@
  196.  
  197.  
  198. ## ---------------------------------------------------
  199. Which method would you like to use to gather data about available rows? 
  200.  
  201.   1) container : [DEFAULT]  This access method uses a netsnmp_container
  202.      to store all row data in memory. This method is best for:
  203.          - Internal data (maintained by the agent)
  204.          - Access speed is important
  205.          - Sufficient memory exists to contain all rows
  206.  
  207.   2) container-cached : This access method uses a netsnmp_container
  208.      to keep track of the indexes (and data, usually) for each 
  209.      row. This method is best for:
  210.          - External data (maintained by another process/the kernel)
  211.          - Access speed is important
  212.          - Sufficient memory exists to contain all indexes
  213.      
  214.   3) unsorted-external : This access method iterates over all of your data
  215.      to find the row with the appropriate index. This method is good for
  216.          - External data (maintained by another process/the kernel)
  217.          - Using less memory is much more important than access speed
  218.      
  219. @      prompt $ans Select your choice : @
  220. @      if $ans == 3@
  221. @        eval $m2c_temp_table_access = "unsorted-external"@
  222. @      elsif $ans == 2@
  223. @        eval $m2c_temp_table_access = "container-cached"@
  224. @        eval $m2c_temp_data_cache = 1@
  225. @      else@
  226. @        eval $m2c_temp_table_access = "container-cached"@
  227. @        eval $m2c_temp_data_cache = 0@
  228. @      end@
  229.  
  230.  
  231. ## ---------------------------------------------------
  232. When accessing your data, is your data TRANSIENT?
  233.  
  234.   1) Yes. My data is TRANSIENT (e.g. a pointer to a static buffer that
  235.      my be overwritten during a request) and needs to be copied during
  236.      processing.
  237.  
  238.   2) Yes. My data is SEMI-TRANSIENT (e.g. an allocated pointer to a
  239.      copy of the data).
  240.  
  241.   3) No, my data is PERSISTENT (e.g. an allocated pointer to the actual
  242.      data, which is under the agent's control)
  243. ## '
  244.   
  245. @      prompt $ans Select your choice [DEFAULT=1] : @
  246. @      if $ans == 3@
  247. @        eval $m2c_temp_data_transient = 0@
  248. @      elsif $ans == 2@
  249. @        eval $m2c_temp_data_transient = 1@
  250. @      else@
  251. @        eval $m2c_temp_data_transient = 2@
  252. @      end@
  253.  
  254.  
  255. ## ---------------------------------------------------
  256. Do you want example code to be generated? This will generate example code
  257. for reading data from a text file.
  258.  
  259.   1) generate example code [DEFAULT]
  260.   2) do not generate example code
  261.  
  262. @      prompt $ans Select your choice : @
  263. @      if $ans == 2@
  264. @        eval $m2c_temp_include_examples = 0@
  265. @      else@
  266. @        eval $m2c_temp_include_examples = 1@
  267. @      end@
  268.  
  269. ## ---------------------------------------------------
  270. Is your table sparse? A sparse table is a table where some
  271. columns might not exist for all rows. Note that if your table
  272. contains a RowStaus column and it supports createAndWait, you
  273. will need sparse table support.
  274.  
  275.   1) No, all columns always exist for every row [DEFAULT]
  276.   2) Yes, my table is sparse
  277.  
  278. @      prompt $ans Select your choice : @
  279. @      if $ans == 2@
  280. @        eval $m2c_temp_table_sparse = 1@
  281. @      end@
  282.  
  283. ## ---------------------------------------------------
  284. Do you want a makefile and AgentX subagent source file generated?
  285. This will let you test your table without having to link it into
  286. snmpd. (You can still link it in later.)
  287.  
  288.   1) do not generate makefile/AgentX code [DEFAULT]
  289.   2) generate makefile/AgentX code
  290.  
  291. @      prompt $ans Select your choice : @
  292. @      if $ans == 2@
  293. @        eval $m2c_temp_generate_makefile = 1@
  294. @        eval $m2c_temp_generate_subagent = 1@
  295. @      else@
  296. @        eval $m2c_temp_generate_makefile = 0@
  297. @        eval $m2c_temp_generate_subagent = 0@
  298. @      end@
  299.  
  300. @   end@ # do not use hardcoded
  301. @end@ # $mfd_interactive_setup == 1
  302. ##################################
  303. ##
  304. ## save values
  305. ##      Note: if you add a var here, add it in m2c_table_save_defaults.m2i too
  306. ##
  307. @eval $m2c_context_reg = "$m2c_temp_context_reg"@
  308. @eval $m2c_data_allocate = $m2c_temp_data_allocate@
  309. @eval $m2c_data_cache = $m2c_temp_data_cache@
  310. @eval $m2c_data_context = "$m2c_temp_data_context"@
  311. @eval $m2c_data_init = $m2c_temp_data_init@
  312. @eval $m2c_data_transient = $m2c_temp_data_transient@
  313. @eval $m2c_include_examples = $m2c_temp_include_examples@
  314. @eval $m2c_irreversible_commit = $m2c_irreversible_commit@
  315. @eval $m2c_table_access = "$m2c_temp_table_access"@
  316. @eval $m2c_table_dependencies = $m2c_temp_dependencies@
  317. @eval $m2c_table_persistent = $m2c_temp_persistent@
  318. @eval $m2c_table_row_creation = $m2c_temp_create@
  319. @eval $m2c_table_settable = $m2c_temp_writable@
  320. @eval $m2c_table_skip_mapping = $m2c_temp_table_skip_mapping@
  321. @eval $m2c_table_sparse = $m2c_temp_table_sparse@
  322. @eval $mfd_generate_makefile = $m2c_temp_generate_makefile@
  323. @eval $mfd_generate_subagent = $m2c_temp_generate_subagent@
  324. ##
  325. ## write them back
  326. ##
  327. @include m2c_table_save_defaults.m2i@
  328. ##
  329. ########################################################################
  330. @if $m2c_mark_boundary == 1@
  331. /** END code generated by $RCSfile$ $Revision: 16380 $ */
  332. @end@
  333.